Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix users.rst #42

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix users.rst #42

wants to merge 4 commits into from

Conversation

etanot
Copy link
Contributor

@etanot etanot commented Jul 14, 2021

Fix some typos, formatting issue and punctuation in users.rst

Capitalize first character of the sentence to make things consistent
with other columns.
'shell' column of 'passwd' table isn't formatted properly because of
misalignment of '|' and '+' symbol.
There is no need for a period after colon punctuation. Also the remove
space between sentence and colon. If a complete sentence precedes by
colon, there is no need for a space between sentence and colon.
Copy link
Owner

@kushaldas kushaldas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR.

One minor change required.

Each line has seven entries separated by *:*.

::
Each line has seven entries separated by::
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is missing the vital : part, which is the separator.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For Sphinx below two things are same:

Each line has seven entries separated by::
Each line has seven entries separated by:

::

When we generate output, Sphinx will automatically expands ending ::, with : followed by a :: code-directive, see below screenshot. In output, we're still getting a : at the end of sentence.

users

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants